Conversation
|
Nginx |
…s for certificates
kairu-ms
left a comment
There was a problem hiding this comment.
Please add examples for commands
| @@ -0,0 +1,4 @@ | |||
| { | |||
| "azext.isExperimental": true, | |||
There was a problem hiding this comment.
Do you want to release this extension in experimental, preview or GA?
There was a problem hiding this comment.
GA. Changing this to false
Co-authored-by: kai ru <69238381+kairu-ms@users.noreply.github.com>
Co-authored-by: kai ru <69238381+kairu-ms@users.noreply.github.com>
src/nginx/azext_nginx/_help.py
Outdated
| helps['nginx deployment list'] = """ | ||
| type: command | ||
| short-summary: "List all Nginx Deployments under the specified resource group; List all deployments under the specified subscription." | ||
| examples: | ||
| - name: Deployments_ListByResourceGroup | ||
| text: |- | ||
| az nginx deployment list --resource-group myResourceGroup | ||
| - name: Deployments_List | ||
| text: |- | ||
| az nginx deployment list | ||
| """ |
There was a problem hiding this comment.
Because you use aaz-dev-tools to generate atomic commands. You should add examples and summaries in aaz-dev-tools. When you generate code, that information will be contained in the Command class description. Instead of writing them in _help.py file.
There was a problem hiding this comment.
Please create a PR to submit the atomic command models in aaz as well.
Created PR Azure/aaz#24
There was a problem hiding this comment.
Because you use aaz-dev-tools to generate atomic commands. You should add examples and summaries in aaz-dev-tools. When you generate code, that information will be contained in the Command class description. Instead of writing them in _help.py file.
Oh. Thanks for this. Done
|
Please create a PR to submit the atomic command models in aaz as well. |
Co-authored-by: kai ru <69238381+kairu-ms@users.noreply.github.com>
| parameters: | ||
| - name: --certificate-path | ||
| This path must match one or more ssl_certificate_key directive file argument in your Nginx configuration. This path must be unique between certificates within the same deployment | ||
| - name: --key-path | ||
| This path must match one or more ssl_certificate directive file argument in your Nginx configuration. This path must be unique between certificates within the same deployment | ||
| - name: --key-vault-secret-id | ||
| The secret ID for your certificate from Azure Key Vault |
There was a problem hiding this comment.
Parameter help message should be in the argument short-summery or long-summery in aaz-dev-tools.
There was a problem hiding this comment.
Done. I've also updated this on the aaz repo PR
src/nginx/azext_nginx/aaz/latest/nginx/deployment/configuration/_create.py
Outdated
Show resolved
Hide resolved
src/nginx/azext_nginx/aaz/latest/nginx/deployment/configuration/_create.py
Outdated
Show resolved
Hide resolved
src/nginx/azext_nginx/aaz/latest/nginx/deployment/configuration/_update.py
Outdated
Show resolved
Hide resolved
…n/_create.py Co-authored-by: kai ru <69238381+kairu-ms@users.noreply.github.com>
…n/_update.py Co-authored-by: kai ru <69238381+kairu-ms@users.noreply.github.com>
Co-authored-by: kai ru <69238381+kairu-ms@users.noreply.github.com>
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 5305 in repo Azure/azure-cli-extensions |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
[Release] Update index.json for extension [ nginx ] : https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6256&view=results |
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally?For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.The precondition is to put your code inside this repository and upgrade the version in the pull request but do not modify
src/index.json.